/*
 * Copyright (c) 2002-2010 Atsuhiko Yamanaka, JCraft,Inc.  All rights reserved.
 * Copyright (c) 2010-2011 Michael Laudati, N1 Concepts LLC.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The names of the authors may not be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
 * INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.vngx.jsch.proxy;

import org.vngx.jsch.util.SocketFactory;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.Socket;

/**
 * Interface defining a proxy which acts as an intermediary for requests from 
 * clients seeking resources from other servers.
 * 
 * @author Atsuhiko Yamanaka
 * @author Michael Laudati
 */
public interface Proxy {

	/**
	 * Connects the proxy using the specified socket factory to create sockets
	 * to the specified host and port with the specified timeout.
	 * 
	 * @param socketFactory
	 * @param host
	 * @param port
	 * @param timeout
	 * @throws Exception
	 */
	void connect(SocketFactory socketFactory, String host, int port, int timeout) throws Exception;

	/**
	 * Returns the input stream from the connected socket.
	 *
	 * @return input stream
	 */
	InputStream getInputStream();

	/**
	 * Returns the output stream from the connected socket.
	 *
	 * @return output stream
	 */
	OutputStream getOutputStream();

	/**
	 * Returns the connected socket.
	 *
	 * @return connected socket
	 */
	Socket getSocket();

	/**
	 * Closes any open resources including the socket connection.
	 */
	void close();

}
